Skip to content

docs: create CONTRIBUTING.md #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Dec 10, 2024
Merged

docs: create CONTRIBUTING.md #11

merged 1 commit into from
Dec 10, 2024

Conversation

okineadev
Copy link
Collaborator

Add a CONTRIBUTING.md file to the repository.

  • Guidelines for Contributing: Include a section for guidelines on contributing to the project.
  • Setting Up the Development Environment: Provide instructions for forking the project, creating a new branch, and installing dependencies using Bun. Include installation commands for Bun on Windows, Linux, macOS, and Windows (WSL).
  • Running Tests and Building the Project: Add instructions for running tests and building the project using Bun.
  • Submitting Pull Requests: Include steps for committing changes, pushing the branch to the fork, and opening a pull request on GitHub.
  • Code of Conduct: Reference the CODE_OF_CONDUCT.md file for behavior expectations.

@okineadev
Add CONTRIBUTING.md to this project
544b733 
Add a `CONTRIBUTING.md` file to the repository.

* **Guidelines for Contributing**: Include a section for guidelines on contributing to the project.
* **Setting Up the Development Environment**: Provide instructions for forking the project, creating a new branch, and installing dependencies using Bun. Include installation commands for Bun on Windows, Linux, macOS, and Windows (WSL).
* **Running Tests and Building the Project**: Add instructions for running tests and building the project using Bun.
* **Submitting Pull Requests**: Include steps for committing changes, pushing the branch to the fork, and opening a pull request on GitHub.
* **Code of Conduct**: Reference the `CODE_OF_CONDUCT.md` file for behavior expectations.
@okineadev okineadev changed the title Add CONTRIBUTING.md to this project docs: create CONTRIBUTING.md Dec 10, 2024
@okineadev okineadev merged commit 7f0ff51 into master Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@okineadev